Skip to content

wiki for apis and products #21595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leniatgh merged 16 commits into from
Jan 26, 2023
Merged

wiki for apis and products #21595

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
c8e9dad
wiki for apis and products
malincrist Oct 26, 2022
35e7540
prettier; fixed spellchecks
malincrist Nov 10, 2022
b7aae04
Fixed spelling
malincrist Nov 10, 2022
9f5938e
Updated path
malincrist Nov 29, 2022
db165ec
code review changes; gihub checks fixes
malincrist Nov 30, 2022
bcd86bc
Merge branch 'release-apimangement-2022-08-01' of https://github.com/…
malincrist Nov 30, 2022
6a9186a
fixed conact name and paths
malincrist Nov 30, 2022
6f3c507
added properties back
malincrist Nov 30, 2022
35b5e76
added contract properties objects
malincrist Nov 30, 2022
a5a7106
fixed lint
malincrist Nov 30, 2022
bf7b3a0
changed example to match the definition
malincrist Nov 30, 2022
b5badfa
prettier
malincrist Nov 30, 2022
265a88d
code review changes
malincrist Dec 6, 2022
54c7a08
added paths and examples for wiki collections
malincrist Dec 6, 2022
6960157
Added x-ms-pageable
malincrist Jan 9, 2023
e2b8e7d
removed count
malincrist Jan 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions ...imanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/apimanagement.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -830,6 +830,17 @@
"minLength": 1,
"maxLength": 80,
"x-ms-parameter-location": "method"
},
"DocumentationIdParameter": {
"name": "documentationId",
"in": "path",
"required": true,
"type": "string",
"description": "Documentation identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 256,
"pattern": "^[^*#&+:<>?]+$",
"x-ms-parameter-location": "method"
}
}
}
277 changes: 277 additions & 0 deletions ...on/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/apimapis.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4415,6 +4415,283 @@
},
"x-ms-odata": "./definitions.json#/definitions/TagResourceContract"
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/wikis/default": {
"head": {
Copy link

@raosuhas raosuhas Jan 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

head

I dont think ARM supports the HEAD method. Why do you need this for ? #Resolved

Copy link
Member Author

@malincrist malincrist Jan 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have HEAD method for most of our specifications. It is used to set the ETag header.

Copy link

@raosuhas raosuhas Jan 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like I was mistaken , there are a couple of other RPs using HEAD as well. Thanks.

"tags": [
"ApiWiki"
],
"operationId": "ApiWiki_GetEntityTag",
"description": "Gets the entity state (Etag) version of the Wiki for an API specified by its identifier.",
"x-ms-examples": {
"ApiManagementHeadApiWiki": {
"$ref": "./examples/ApiManagementHeadApiWiki.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Operation completed successfully.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
},
"get": {
"tags": [
"ApiWiki"
],
"operationId": "ApiWiki_Get",
"description": "Gets the details of the Wiki for an API specified by its identifier.",
"x-ms-examples": {
"ApiManagementGetApiWiki": {
"$ref": "./examples/ApiManagementGetApiWiki.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The response body contains the specified Wiki entity.",
"schema": {
"$ref": "./definitions.json#/definitions/WikiContract"
},
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
},
"put": {
"tags": [
"ApiWiki"
],
"operationId": "ApiWiki_CreateOrUpdate",
"description": "Creates a new Wiki for an API or updates an existing one.",
"x-ms-examples": {
"ApiManagementCreateApiWiki": {
"$ref": "./examples/ApiManagementCreateApiWiki.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "./definitions.json#/definitions/WikiContract"
},
"description": "Create parameters."
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"201": {
"description": "Wiki was successfully created.",
"schema": {
"$ref": "./definitions.json#/definitions/WikiContract"
},
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"200": {
"description": "Wiki was successfully updated.",
"schema": {
"$ref": "./definitions.json#/definitions/WikiContract"
},
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
},
"patch": {
"tags": [
"ApiWiki"
],
"operationId": "ApiWiki_Update",
"description": "Updates the details of the Wiki for an API specified by its identifier.",
"x-ms-examples": {
"ApiManagementUpdateApiWiki": {
"$ref": "./examples/ApiManagementUpdateApiWiki.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "./definitions.json#/definitions/WikiContract"
},
"description": "Wiki Update parameters."
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Wiki was successfully updated.",
"schema": {
"$ref": "./definitions.json#/definitions/WikiContract"
},
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"ApiWiki"
],
"operationId": "ApiWiki_Delete",
"description": "Deletes the specified Wiki from an API.",
"x-ms-examples": {
"ApiManagementDeleteApiWiki": {
"$ref": "./examples/ApiManagementDeleteApiWiki.json"
}
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Wiki successfully removed"
},
"204": {
"description": "Wiki successfully removed by previous request or does not exist"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
}
}
},
"x-ms-paths": {
Expand Down
Loading