Add a new resource to get the overview markdown content of an API #12942
Conversation
AqeelMuhammad
requested review from
tharindu1st,
AnuGayan,
chamilaadhi,
Arshardh,
dushaniw and
tgtshanika
as code owners
WalkthroughThis pull request introduces support for retrieving and managing Markdown overview documentation for APIs and API products. A new method is added to the API management interfaces and implemented across multiple classes, along with corresponding changes to the API model classes by adding an Changes
Sequence Diagram(s)sequenceDiagram
participant C as Client
participant A as ApisApiServiceImpl
participant AC as APIConsumerImpl
participant AM as AbstractAPIManager
participant RP as RegistryPersistenceImpl
C->>A: GET /apis/{apiId}/markdown-content
A->>AC: getMarkdownOverviewContent(apiId, organization)
AC->>AM: getMarkdownOverviewContent(apiId, organization)
AM->>RP: searchDocumentation(apiId, "other:_overview")
RP-->>AM: Documentation content (or null)
AM-->>AC: Markdown content (or null) with error handling
AC-->>A: Response with markdown content
A-->>C: HTTP response with content/headers
Suggested reviewers
Poem
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/devportal-api.yaml (1)
839-892: New Endpoint Implementation: Markdown Content RetrievalThe new endpoint
/apis/{apiId}/markdown-contentis added to directly retrieve the API overview markdown document content, which aligns with the PR objectives. The endpoint’s summary, description, parameters, and security settings are clearly defined. One minor suggestion is to verify if the 200 response’s content is intended to return inline markdown text under a specific media type (for example,text/plain) rather than an empty object. If a content schema is required, consider specifying it for better documentation and client clarity.components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/resources/devportal-api.yaml (1)
839-892: New API Overview Markdown Endpoint Added
The new/apis/{apiId}/markdown-contentGET endpoint is clearly defined with an informative summary and description. It follows the style of existing endpoints by using standard parameters (such asapiId,requestedTenant, andIf-None-Match) and response codes (200, 304, 404, and 406).However, the response body definition under the
200response is currently an empty content object. Since the endpoint is expected to return inline markdown content intext/plainformat, consider explicitly specifying the media type and its schema. For example, you might add a content section like this:- responses: - 200: - description: | - OK. - Inline content returned. - headers: - ETag: - description: | - Entity Tag of the response resource. - Used by caches, or in conditional requests. - schema: - type: string - Last-Modified: - description: | - Date and time the resource has been modified the last time. - Used by caches, or in conditional requests. - schema: - type: string - content: { } + responses: + 200: + description: | + OK. + Inline markdown content returned. + headers: + ETag: + description: Entity Tag of the response resource. Used by caches or in conditional requests. + schema: + type: string + Last-Modified: + description: Date and time the resource was last modified. + schema: + type: string + content: + text/plain: + schema: + type: stringThis explicit declaration enhances clarity for API consumers.
components/apimgt/org.wso2.carbon.apimgt.impl/src/test/java/org/wso2/carbon/apimgt/impl/APIConsumerImplTest.java (1)
40-40: Consider using specific imports rather than wildcard imports.Wildcard imports make it harder to track which specific classes are being used and can lead to namespace conflicts. Consider using specific imports for better code maintainability.
-import org.wso2.carbon.apimgt.api.model.*; +import org.wso2.carbon.apimgt.api.model.AccessTokenInfo; +import org.wso2.carbon.apimgt.api.model.API; +import org.wso2.carbon.apimgt.api.model.APIIdentifier; +import org.wso2.carbon.apimgt.api.model.APIKey; +import org.wso2.carbon.apimgt.api.model.Application; +import org.wso2.carbon.apimgt.api.model.Comment; +import org.wso2.carbon.apimgt.api.model.DocumentationContent; +import org.wso2.carbon.apimgt.api.model.OAuthAppRequest; +import org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo; +import org.wso2.carbon.apimgt.api.model.Scope; +import org.wso2.carbon.apimgt.api.model.Subscriber; +import org.wso2.carbon.apimgt.api.model.SubscribedAPI; +import org.wso2.carbon.apimgt.api.model.Tier; +import org.wso2.carbon.apimgt.api.model.APIRating; +import org.wso2.carbon.apimgt.api.model.AccessTokenRequest; +import org.wso2.carbon.apimgt.api.model.ApiTypeWrapper;components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/model/APIProduct.java (1)
721-727: Consider documenting the new feature with JavaDoc comments.Adding descriptive JavaDoc comments for the new methods would improve API documentation and help developers understand the purpose of the
isMarkdownOverviewproperty.+/** + * Checks if this API Product has a Markdown overview document. + * + * @return true if this API Product has a Markdown overview document, false otherwise + */ public Boolean isMarkdownOverview() { return isMarkdownOverview; } +/** + * Sets whether this API Product has a Markdown overview document. + * + * @param isMarkdownOverview boolean indicating if the API Product has a Markdown overview document + */ public void setMarkdownOverview(Boolean isMarkdownOverview) { this.isMarkdownOverview = isMarkdownOverview; }components/apimgt/org.wso2.carbon.apimgt.impl/src/test/java/org/wso2/carbon/apimgt/impl/AbstractAPIManagerTestCase.java (1)
260-289: Complete test coverage for the new functionalityThe test method effectively verifies the
getMarkdownOverviewContentmethod inAbstractAPIManagerwhen no documentation is found. It:
- Sets up the necessary mocks including ServiceReferenceHolder and configuration services
- Configures the apiPersistenceInstance mock to return an empty document list
- Verifies that the result is null when no documentation is found
Consider adding an additional test case that verifies behavior when documentation is found. This would provide complete coverage of the success path:
+ @Test + public void testGetMarkdownOverviewContentWhenExists() throws Exception { + String apiId = "sample-api-id"; + String organization = "sample-org"; + String expectedContent = "# API Overview\nThis is a sample markdown content."; + + AbstractAPIManager abstractAPIManager = new AbstractAPIManagerWrapper(apiPersistenceInstance); + + PowerMockito.mockStatic(ServiceReferenceHolder.class); + ServiceReferenceHolder sh = Mockito.mock(ServiceReferenceHolder.class); + APIManagerConfigurationService amConfigService = Mockito.mock(APIManagerConfigurationService.class); + APIManagerConfiguration amConfig = Mockito.mock(APIManagerConfiguration.class); + + PowerMockito.when(ServiceReferenceHolder.getInstance()).thenReturn(sh); + PowerMockito.when(sh.getAPIManagerConfigurationService()).thenReturn(amConfigService); + PowerMockito.when(amConfigService.getAPIManagerConfiguration()).thenReturn(amConfig); + + // Create mock documentation and search result + org.wso2.carbon.apimgt.persistence.dto.Documentation mockDoc = Mockito.mock(org.wso2.carbon.apimgt.persistence.dto.Documentation.class); + List<org.wso2.carbon.apimgt.persistence.dto.Documentation> docList = Collections.singletonList(mockDoc); + DocumentSearchResult searchResult = Mockito.mock(DocumentSearchResult.class); + Mockito.when(searchResult.getDocumentationList()).thenReturn(docList); + + // Set up mock DocumentContent + DocumentContent documentContent = Mockito.mock(DocumentContent.class); + Mockito.when(documentContent.getContent()).thenReturn(expectedContent); + + // Configure apiPersistenceInstance to return the search result and document content + Mockito.when(apiPersistenceInstance.searchDocumentation( + Mockito.any(Organization.class), + Mockito.eq(apiId), + Mockito.eq(0), + Mockito.eq(0), + Mockito.eq("other:_overview"), + Mockito.isNull() + )).thenReturn(searchResult); + Mockito.when(apiPersistenceInstance.getDocumentationContent( + Mockito.any(Organization.class), + Mockito.eq(apiId), + Mockito.anyString() + )).thenReturn(documentContent); + + // Execute the method under test + DocumentationContent result = abstractAPIManager.getMarkdownOverviewContent(apiId, organization); + + // Verify the result + Assert.assertNotNull(result); + Assert.assertEquals(expectedContent, result.getTextContent()); + }components/apimgt/org.wso2.carbon.apimgt.persistence/src/main/java/org/wso2/carbon/apimgt/persistence/RegistryPersistenceImpl.java (1)
2816-2821: Enhanced documentation search capabilities by adding support for 'other:' query prefix.This addition enhances the documentation search functionality by allowing users to search documentation based on the "other type name" property, making it possible to find specific documentation types like markdown overviews more efficiently.
Consider adding null checking for the
searchQueryparameter before applyingtoLowerCase()andsplit(":")to prevent potential NullPointerExceptions. The following pattern would be safer:-else if (searchQuery.toLowerCase().startsWith("other:")) { - String requestedDocOtherTypeName = searchQuery.split(":")[1]; +else if (searchQuery != null && searchQuery.toLowerCase().startsWith("other:")) { + String[] parts = searchQuery.split(":"); + if (parts.length > 1) { + String requestedDocOtherTypeName = parts[1]; + if (doc.getOtherTypeName() != null + && doc.getOtherTypeName().equalsIgnoreCase(requestedDocOtherTypeName)) { + documentationList.add(doc); + } + }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/gen/java/org/wso2/carbon/apimgt/rest/api/store/v1/ApisApi.javais excluded by!**/gen/**components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/gen/java/org/wso2/carbon/apimgt/rest/api/store/v1/ApisApiService.javais excluded by!**/gen/**components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/gen/java/org/wso2/carbon/apimgt/rest/api/store/v1/dto/APIDTO.javais excluded by!**/gen/**
📒 Files selected for processing (15)
components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/APIManager.java(1 hunks)components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/model/API.java(2 hunks)components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/model/APIProduct.java(2 hunks)components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIConsumerImpl.java(2 hunks)components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/AbstractAPIManager.java(1 hunks)components/apimgt/org.wso2.carbon.apimgt.impl/src/test/java/org/wso2/carbon/apimgt/impl/APIConsumerImplTest.java(2 hunks)components/apimgt/org.wso2.carbon.apimgt.impl/src/test/java/org/wso2/carbon/apimgt/impl/AbstractAPIManagerTestCase.java(1 hunks)components/apimgt/org.wso2.carbon.apimgt.persistence/src/main/java/org/wso2/carbon/apimgt/persistence/RegistryPersistenceImpl.java(1 hunks)components/apimgt/org.wso2.carbon.apimgt.persistence/src/main/java/org/wso2/carbon/apimgt/persistence/dto/DevPortalAPI.java(3 hunks)components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/devportal-api.yaml(2 hunks)components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/java/org/wso2/carbon/apimgt/rest/api/store/v1/impl/ApisApiServiceImpl.java(1 hunks)components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/java/org/wso2/carbon/apimgt/rest/api/store/v1/mappings/APIMappingUtil.java(2 hunks)components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/resources/devportal-api.yaml(2 hunks)features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/templates/repository/conf/api-manager.xml.j2(2 hunks)features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/config/api-manager.xml(2 hunks)
🔇 Additional comments (20)
components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/APIManager.java (1)
233-242: Clean implementation of the new method to support markdown overview content retrieval.The new
getMarkdownOverviewContentmethod is well-designed and properly documented. It aligns perfectly with the PR objective of enabling direct access to API overview markdown content without requiring multiple API calls. The signature follows the existing patterns in the interface, taking an API ID and organization identifier as parameters and returning the appropriateDocumentationContenttype.This implementation enhances the API management functionality by providing a streamlined way to access overview documentation, which improves developer experience.
components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/devportal-api.yaml (1)
4136-4139: New API Schema Property: isMarkdownOverviewThe addition of the
isMarkdownOverviewboolean field in the API schema is well implemented. It clearly indicates whether an API has an associated markdown overview document, which is central to this PR. The example provided is helpful. Please ensure that any related components (such as model classes or getters/setters) are updated accordingly in the rest of the codebase.components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/resources/devportal-api.yaml (1)
4136-4138: New API Schema Property: isMarkdownOverview
The addition of theisMarkdownOverviewboolean property in the API object schema is appropriate and aligns well with the PR objectives. It clearly signals whether an API has an associated Markdown overview document. Including an example value (true) further aids comprehension.features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/config/api-manager.xml (2)
457-460: Configuration looks good for the API markdown content endpoint.The new AllowedURI configuration properly adds authorization exemptions for the markdown content endpoint for APIs, allowing GET and HEAD operations without requiring authentication.
521-524: Configuration looks good for the API Product markdown content endpoint.The new AllowedURI configuration properly adds authorization exemptions for the markdown content endpoint for API products, allowing GET and HEAD operations without requiring authentication.
components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/model/API.java (2)
149-149: Field declaration looks good.The
isMarkdownOverviewfield is appropriately declared as a Boolean object rather than a primitive, allowing for null values which is consistent with similar fields in this class.
1409-1415: Getter and setter methods are properly implemented.The getter and setter methods for the
isMarkdownOverviewproperty follow Java Bean naming conventions and are correctly implemented. The methods are consistent with other similar methods in the class.components/apimgt/org.wso2.carbon.apimgt.api/src/main/java/org/wso2/carbon/apimgt/api/model/APIProduct.java (2)
68-68: Field declaration looks good.The
isMarkdownOverviewfield is appropriately declared as a Boolean object rather than a primitive, allowing for null values which is consistent with similar fields in this class.
721-727: Getter and setter methods are properly implemented.The getter and setter methods for the
isMarkdownOverviewproperty follow Java Bean naming conventions and are correctly implemented. The methods are consistent with other similar methods in the class.components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/java/org/wso2/carbon/apimgt/rest/api/store/v1/impl/ApisApiServiceImpl.java (1)
1221-1246:✅ Verification successful
Well-structured implementation for retrieving markdown content
The implementation follows the established patterns in the rest of the class:
- Properly validates the organization from the message context
- Obtains the logged-in user consumer
- Handles the null content case appropriately
- Returns the content with proper content-type header
- Implements comprehensive error handling with specific messages
Run the following to verify this endpoint meets the requirements described in the PR objectives:
🏁 Script executed:
#!/bin/bash # Verify integration with related components # Check if the APIConsumer interface has the getMarkdownOverviewContent method rg -A 5 "getMarkdownOverviewContent" --type javaLength of output: 6768
Endpoint Implementation Verified – All Criteria Met
- The method correctly validates the organization, retrieves the logged-in user consumer, and handles null documentation content as expected.
- The proper content-type header is set and error handling is comprehensive, addressing both missing resources and internal errors.
- Verification confirms that the
APIConsumerinterface provides thegetMarkdownOverviewContentmethod, ensuring integration with related components is intact.components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/AbstractAPIManager.java (1)
501-516: Well implemented method to retrieve Markdown overview content.The new
getMarkdownOverviewContentmethod is well-structured and follows consistent error handling patterns. It efficiently searches for documentation with "other:_overview" prefix and returns the content or null if not found.components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/java/org/wso2/carbon/apimgt/rest/api/store/v1/mappings/APIMappingUtil.java (2)
104-104: Property mapping implementation looks good.The mapping of
isMarkdownOverviewfrom the API model to the DTO follows consistent patterns with other properties.
309-309: Property mapping for APIProduct is consistent.The mapping of
isMarkdownOverviewfor APIProduct matches the implementation in the API model, ensuring consistent behavior across both entity types.components/apimgt/org.wso2.carbon.apimgt.persistence/src/main/java/org/wso2/carbon/apimgt/persistence/dto/DevPortalAPI.java (3)
71-71: Appropriately placed field declaration.The new
isMarkdownOverviewfield follows the existing pattern for Boolean properties in this class.
361-367: Well-implemented getter and setter methods.The accessor methods follow Java conventions with the "is" prefix for the boolean getter, which correctly indicates this is a boolean property.
387-387: Properly updated toString method.The
toString()method appropriately includes the new field, maintaining complete object representation for debugging.features/apimgt/org.wso2.carbon.apimgt.core.feature/src/main/resources/conf_templates/templates/repository/conf/api-manager.xml.j2 (2)
741-744: Addition of new allowed URI for API markdown content accessThis configuration adds a new endpoint to allow unauthenticated access to the markdown content of APIs through the Developer Portal. This aligns with the PR objective to provide direct access to API overview markdown content.
809-812: Addition of new allowed URI for API Product markdown content accessThis configuration extends the markdown content retrieval functionality to API Products, allowing unauthenticated access to API Product overview markdown content. This is a logical extension of the feature to ensure consistency between APIs and API Products.
components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIConsumerImpl.java (2)
3963-3970: Implementation of markdown overview detection looks good and efficient.The code correctly checks if any document in the API has the
_overviewtype and sets themarkdownOverviewflag accordingly. This implementation efficiently determines whether an API has markdown overview content without requiring additional API calls.
4425-4432: Well-implemented access control for markdown overview content.This method provides a secure way to retrieve markdown overview content by first checking API visibility restrictions before delegating to the superclass implementation. The proper authorization checks help ensure that only users with the appropriate permissions can access the markdown content.
| @Test | ||
| public void testGetMarkdownOverviewContent() throws Exception { | ||
| String apiId = "api123"; | ||
| String organization = "wso2"; | ||
| DocumentationContent mockContent = new DocumentationContent(); | ||
|
|
||
| APIConsumerImpl apiConsumer = PowerMockito.spy(new APIConsumerImplWrapper()); | ||
|
|
||
| PowerMockito.doNothing().when(apiConsumer).checkAPIVisibilityRestriction(apiId, organization); | ||
| PowerMockito.doReturn(mockContent).when(apiConsumer, "getMarkdownOverviewContent", apiId, organization); | ||
|
|
||
| DocumentationContent result = apiConsumer.getMarkdownOverviewContent(apiId, organization); | ||
|
|
||
| Assert.assertNotNull(result); | ||
| Assert.assertEquals(mockContent, result); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Test implementation has a potential issue.
The test is attempting to test the getMarkdownOverviewContent method while simultaneously mocking its behavior with doReturn(mockContent).when(apiConsumer, "getMarkdownOverviewContent", ...). This creates a circular dependency where the method's implementation is bypassed, potentially leading to false positives.
Consider revising the test to either:
- Mock the dependencies of
getMarkdownOverviewContentinstead of mocking the method itself - Add verification that the method calls necessary dependencies with correct parameters
@Test
public void testGetMarkdownOverviewContent() throws Exception {
String apiId = "api123";
String organization = "wso2";
DocumentationContent mockContent = new DocumentationContent();
+ mockContent.setSourceType("MARKDOWN");
+ mockContent.setContent("# API Overview");
APIConsumerImpl apiConsumer = PowerMockito.spy(new APIConsumerImplWrapper());
+ API api = new API(new APIIdentifier("provider", "name", "1.0.0"));
+ api.setUuid(apiId);
+ api.setMarkdownOverview(true);
+
+ PowerMockito.doReturn(api).when(apiConsumer).getAPIbyUUID(apiId, organization);
+ PowerMockito.doReturn(mockContent).when(apiConsumer).getAPIDocumentationContent(
+ Mockito.anyString(), Mockito.anyString());
- PowerMockito.doNothing().when(apiConsumer).checkAPIVisibilityRestriction(apiId, organization);
- PowerMockito.doReturn(mockContent).when(apiConsumer, "getMarkdownOverviewContent", apiId, organization);
DocumentationContent result = apiConsumer.getMarkdownOverviewContent(apiId, organization);
Assert.assertNotNull(result);
- Assert.assertEquals(mockContent, result);
+ Assert.assertEquals("# API Overview", result.getContent());
+ Assert.assertEquals("MARKDOWN", result.getSourceType());
+
+ // Verify that visibility check was performed
+ PowerMockito.verifyPrivate(apiConsumer).invoke("checkAPIVisibilityRestriction", apiId, organization);
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| @Test | |
| public void testGetMarkdownOverviewContent() throws Exception { | |
| String apiId = "api123"; | |
| String organization = "wso2"; | |
| DocumentationContent mockContent = new DocumentationContent(); | |
| APIConsumerImpl apiConsumer = PowerMockito.spy(new APIConsumerImplWrapper()); | |
| PowerMockito.doNothing().when(apiConsumer).checkAPIVisibilityRestriction(apiId, organization); | |
| PowerMockito.doReturn(mockContent).when(apiConsumer, "getMarkdownOverviewContent", apiId, organization); | |
| DocumentationContent result = apiConsumer.getMarkdownOverviewContent(apiId, organization); | |
| Assert.assertNotNull(result); | |
| Assert.assertEquals(mockContent, result); | |
| } | |
| @Test | |
| public void testGetMarkdownOverviewContent() throws Exception { | |
| String apiId = "api123"; | |
| String organization = "wso2"; | |
| DocumentationContent mockContent = new DocumentationContent(); | |
| mockContent.setSourceType("MARKDOWN"); | |
| mockContent.setContent("# API Overview"); | |
| APIConsumerImpl apiConsumer = PowerMockito.spy(new APIConsumerImplWrapper()); | |
| API api = new API(new APIIdentifier("provider", "name", "1.0.0")); | |
| api.setUuid(apiId); | |
| api.setMarkdownOverview(true); | |
| PowerMockito.doReturn(api).when(apiConsumer).getAPIbyUUID(apiId, organization); | |
| PowerMockito.doReturn(mockContent).when(apiConsumer).getAPIDocumentationContent( | |
| Mockito.anyString(), Mockito.anyString()); | |
| DocumentationContent result = apiConsumer.getMarkdownOverviewContent(apiId, organization); | |
| Assert.assertNotNull(result); | |
| Assert.assertEquals("# API Overview", result.getContent()); | |
| Assert.assertEquals("MARKDOWN", result.getSourceType()); | |
| // Verify that visibility check was performed | |
| PowerMockito.verifyPrivate(apiConsumer).invoke("checkAPIVisibilityRestriction", apiId, organization); | |
| } |
Purpose
A new resource
/apis/{apiId}/markdown-contentis created to fetch the overview markdown content of an API.In the current implementation, to obtain the markdown content, the
documentIdrelated to the overview document needs to be known. So, at least three APIs should be called, including the GET/apis/{apiId}API, to fetch the markdown content.From the new resource, we can directly obtain the markdown content if
isMarkdownOverviewistruein the GET/apis/{apiId}API.Summary by CodeRabbit
New Features
Tests