chg: [doc] Document use of local parameter in API for tags/galaxies

pull/7892/head
Loïc Fortemps 2021-10-28 12:09:10 +02:00
parent 7c4b36b1d3
commit a33a632627
No known key found for this signature in database
GPG Key ID: 98878A7B36234F0D
1 changed files with 24 additions and 3 deletions

View File

@ -212,7 +212,7 @@ paths:
default:
$ref: "#/components/responses/ApiErrorResponse"
/attributes/addTag/{attributeId}/{tagId}:
/attributes/addTag/{attributeId}/{tagId}/local:{local}:
post:
summary: "Add a tag to an attribute"
operationId: tagAttribute
@ -221,6 +221,7 @@ paths:
parameters:
- $ref: "#/components/parameters/attributeIdParameter"
- $ref: "#/components/parameters/tagIdParameter"
- $ref: "#/components/parameters/localParameter"
responses:
"200":
$ref: "#/components/responses/AddAttributeTagResponse"
@ -457,7 +458,7 @@ paths:
default:
$ref: "#/components/responses/ApiErrorResponse"
/events/addTag/{eventId}/{tagId}:
/events/addTag/{eventId}/{tagId}/local:{local}:
post:
summary: "Add event tag"
operationId: tagEvent
@ -466,6 +467,7 @@ paths:
parameters:
- $ref: "#/components/parameters/eventIdParameter"
- $ref: "#/components/parameters/tagIdParameter"
- $ref: "#/components/parameters/localParameter"
responses:
"200":
$ref: "#/components/responses/AddEventTagResponse"
@ -607,7 +609,7 @@ paths:
default:
$ref: "#/components/responses/ApiErrorResponse"
/galaxies/attachCluster/{attachTargetId}/{attachTargetType}:
/galaxies/attachCluster/{attachTargetId}/{attachTargetType}/local:{local}:
post:
summary: "Attach the galaxy cluster tag a given entity"
operationId: attachGalaxyCluster
@ -616,6 +618,7 @@ paths:
parameters:
- $ref: "#/components/parameters/attachTargetIdParameter"
- $ref: "#/components/parameters/attachTargetTypeParameter"
- $ref: "#/components/parameters/localParameter"
requestBody:
$ref: "#/components/requestBodies/AttachGalaxyClusterRequest"
responses:
@ -5302,6 +5305,16 @@ components:
IsLocal:
type: boolean
Local:
type: integer
format: int32
maxLength: 1
default: 0
nullable: false
enum:
- 0
- 1
IsReadOnly:
type: boolean
@ -5692,6 +5705,14 @@ components:
schema:
$ref: "#/components/schemas/TagId"
localParameter:
name: local
in: path
description: "Whether the object should be attached locally or not to the target"
required: false
schema:
$ref: "#/components/schemas/Local"
tagSearchTermParameter:
name: tagSearchTerm
in: path