1.1.0

Huluti · Huluti · commit 3e6b03bfe632 · 2024-02-13T13:32:51.000+01:00
diff --git a/clients/urlr-javascript/CHANGELOG.md b/clients/urlr-javascript/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.1.0] - 2024-02-13
+
+- Add two new endpoints
+- Doc improvements
+- Updated to OpenAPI Generator 7.3.0
+
 ## [1.0.2] - 2024-02-01
 
 - Fix two return types in reduce_link200_response
diff --git a/clients/urlr-php/CHANGELOG.md b/clients/urlr-php/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.1.0] - 2024-02-13
+
+- Add two new endpoints
+- Doc improvements
+- Updated to OpenAPI Generator 7.3.0
+
 ## [1.0.1] - 2024-02-01
 
 - Fix two return types in reduce_link200_response
diff --git a/clients/urlr-python/CHANGELOG.md b/clients/urlr-python/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [1.1.0] - 2024-02-13
+
+- Add two new endpoints
+- Doc improvements
+- Updated to OpenAPI Generator 7.3.0
+
 ## [1.0.1] - 2024-02-01
 
 - Fix two return types in reduce_link200_response
diff --git a/openapi-generator/config-javascript.yaml b/openapi-generator/config-javascript.yaml
@@ -1,5 +1,5 @@
 npmName: urlr-js
-npmVersion: 1.0.2
+npmVersion: 1.1.0
 gitHost: github.com
 gitUserId: urlr
 gitRepoId: urlr-javascript
diff --git a/openapi-generator/config-php.yaml b/openapi-generator/config-php.yaml
@@ -1,6 +1,6 @@
 packageName: URLR
 composerPackageName: urlr/urlr-php
-artifactVersion: 1.0.1
+artifactVersion: 1.1.0
 invokerPackage: URLR
 variableNamingConvention: camelCase
 developerOrganization: URLR
diff --git a/openapi-generator/config-python.yaml b/openapi-generator/config-python.yaml
@@ -1,6 +1,6 @@
 projectName: URLR
 packageName: urlr
-packageVersion: 1.0.1
+packageVersion: 1.1.0
 infoName: URLR
 infoEmail: contact@urlr.me
 gitUserId: urlr
diff --git a/openapi.yaml b/openapi.yaml
@@ -10,7 +10,7 @@ info:
   license:
     name: 'All rights reserved'
     url: 'https://urlr.me/en/legal-notice'
-  version: '0.2'
+  version: '0.3'
 servers:
   -
     url: 'https://urlr.me/api'
@@ -31,8 +31,10 @@ paths:
                 - 'username, password'
               properties:
                 username:
+                  description: Email
                   type: string
                 password:
+                  description: Password
                   type: string
               type: object
       responses:
@@ -57,10 +59,10 @@ paths:
     post:
       tags:
         - Link
-      summary: 'Reduce a link'
+      summary: 'Shorten a link'
       operationId: reduceLink
       requestBody:
-        description: 'Infos of the link to reduce'
+        description: 'Info of the link to shorten'
         content:
           application/json:
             schema:
@@ -69,23 +71,23 @@ paths:
                 - team
               properties:
                 url:
-                  description: 'The url to reduce'
+                  description: 'URL to shorten'
                   type: string
                 team:
-                  description: 'Team id (displayed on dashboard)'
+                  description: 'Team ID (displayed on dashboard)'
                   type: string
                 folder:
-                  description: 'Folder id (displayed on dashboard)'
+                  description: 'Folder ID (displayed on dashboard)'
                   type: string
                 code:
-                  description: 'Custom code'
+                  description: 'Custom short code'
                   type: string
                   pattern: '^[a-zA-Z0-9!-]{3,50}$'
                 label:
-                  description: 'Link label'
+                  description: Label
                   type: string
                 password:
-                  description: 'Link password'
+                  description: Password
                   type: string
                 expired_at:
                   description: 'Expiration date'
@@ -98,12 +100,12 @@ paths:
             application/json:
               schema:
                 properties:
-                  url: { description: 'Input url to reduce', type: string }
+                  url: { description: 'Original URL', type: string }
                   expired_at: { description: 'Expiration date', type: string }
-                  team: { description: 'Team id (displayed on dashboard)', type: integer }
-                  folder: { description: 'Folder id (displayed on dashboard)', type: integer }
-                  url_code: { type: string, example: xMs5c }
-                  domain: { type: string, example: urlr.me }
+                  team: { description: 'Team ID (displayed on dashboard)', type: integer }
+                  folder: { description: 'Folder ID (displayed on dashboard)', type: integer }
+                  url_code: { description: 'Short code', type: string, example: xMs5c }
+                  domain: { description: Domain, type: string, example: urlr.me }
                   code: { description: 'HTTP status code', type: integer, example: 200 }
                 type: object
         '400':
@@ -113,7 +115,7 @@ paths:
               schema:
                 properties:
                   code: { description: 'HTTP status code', type: integer, example: 401 }
-                  error: { type: integer, example: -1 }
+                  error: { description: 'Error code', type: integer, example: -1 }
                   message: { description: 'Message describing the error', type: string }
                 type: object
       security:
@@ -134,7 +136,7 @@ paths:
                 - code
               properties:
                 code:
-                  description: 'The short code of the url'
+                  description: 'The short code of the URL'
                   type: string
                   pattern: '^[a-zA-Z0-9!-]{3,50}$'
                 from:
@@ -156,8 +158,8 @@ paths:
             application/json:
               schema:
                 properties:
-                  clicks: { type: integer, example: 32 }
-                  uniqueClicks: { type: integer, example: 51 }
+                  clicks: { description: Clicks, type: integer, example: 32 }
+                  uniqueClicks: { description: 'Unique clicks', type: integer, example: 51 }
                 type: object
         '400':
           description: 'An error occurred'
@@ -171,6 +173,55 @@ paths:
       security:
         -
           bearerAuth: []
+  /team:
+    get:
+      tags:
+        - Team
+      summary: 'Get teams of user'
+      operationId: team
+      responses:
+        '200':
+          description: 'Teams of user'
+          content:
+            application/json:
+              schema:
+                properties:
+                  teams: { type: array, items: { properties: { id: { description: 'Team ID', type: integer, example: 131 }, name: { description: 'Team name', type: string, example: 'the best team' } }, type: object } }
+                type: object
+      security:
+        -
+          bearerAuth: []
+  /folder:
+    get:
+      tags:
+        - Folder
+      summary: 'Get folders of team'
+      operationId: folder
+      requestBody:
+        description: 'Infos to provide to get folders of team'
+        content:
+          application/json:
+            schema:
+              required:
+                - team
+              properties:
+                team:
+                  description: 'Team ID (displayed on dashboard)'
+                  type: integer
+                  example: 123
+              type: object
+      responses:
+        '200':
+          description: 'Folders of team'
+          content:
+            application/json:
+              schema:
+                properties:
+                  folders: { type: array, items: { properties: { id: { description: 'Folder ID', type: integer, example: 123 }, name: { description: 'Folder name', type: string, example: folder-campaign-google-ads } }, type: object } }
+                type: object
+      security:
+        -
+          bearerAuth: []
 components:
   securitySchemes:
     bearerAuth:
diff --git a/openapitools.json b/openapitools.json
@@ -2,6 +2,6 @@
   "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "7.2.0"
+    "version": "7.3.0"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,6 @@`
`2`	`2`	`"$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",`
`3`	`3`	`"spaces": 2,`
`4`	`4`	`"generator-cli": {`
`5`		`- "version": "7.2.0"`
	`5`	`+ "version": "7.3.0"`
`6`	`6`	`}`
`7`	`7`	`}`