Merge pull request #15008 from eduardoj/fix/issue_14811

Fix documentation of tokens' list API endpoint
openSUSE · Oct 6, 2023 · 55a05a7 · 55a05a7
2 parents c66dc31 + 46cecc7
commit 55a05a7
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/docs/api/api/tokenlist.rng b/docs/api/api/tokenlist.rng
@@ -47,7 +47,7 @@
       </attribute>
 
       <optional>
-       <attribute name="name">
+       <attribute name="description">
         <a:documentation>
          This attribute can be used to identify a token from the list of tokens
          of a user.

diff --git a/docs/api/api/tokenlist.xml b/docs/api/api/tokenlist.xml
@@ -1,5 +1,5 @@
 <directory count="3">
   <entry id="18" string="thisIsASuperSecretValue" kind="rss" triggered_at="2021-10-28 12:32:18 UTC"/>
-  <entry id="265" string="thisIsAnotherSuperSecretValue" kind="runservice" name="Runservice without package" triggered_at="2021-10-28 12:32:18 UTC"/>
+  <entry id="265" string="thisIsAnotherSuperSecretValue" kind="runservice" description="Runservice without package" triggered_at="2021-10-28 12:32:18 UTC"/>
   <entry id="267" string="aSuperSecretValue" kind="release" triggered_at="2021-10-28 12:32:18 UTC" project="devel:libraries:c_c++" package="notmuch"/>
 </directory>
diff --git a/src/api/public/apidocs/components/schemas/person_tokens.yaml b/src/api/public/apidocs/components/schemas/person_tokens.yaml
@@ -13,7 +13,7 @@ properties:
           type: string
           xml:
             attribute: true
-        name:
+        description:
           type: string
           xml:
             attribute: true

diff --git a/src/api/public/apidocs/paths/person_login_token.yaml b/src/api/public/apidocs/paths/person_login_token.yaml
@@ -23,7 +23,7 @@ get:
                 kind: rss
                 triggered_at: '2021-10-28 12:32:18 UTC'
               - id: 25
-                name: Release ghcz
+                description: Release ghcz
                 string: 4T04JGI691
                 kind: release
                 triggered_at: '2021-09-21 11:12:18 UTC'
@@ -60,11 +60,11 @@ post:
   parameters:
     - $ref: '../components/parameters/login.yaml'
     - in: query
-      name: name
+      name: description
       schema:
         type: string
       description: |
-        Token name. It helps to identify a token from the rest of the tokens of a user.
+        Token description. It helps to identify a token from the rest of the tokens of a user.
       example: Rebuild gchz
     - in: query
       name: project