Skip to content

Commit

Permalink
Release 23.8 (#79)
Browse files Browse the repository at this point in the history
* Update Swagger

* Improve dotnet docs for enums

* Improve go docs for enums

* Improve dart docs for enums

* Improve Python docs

* Improve PHP docs

---------

Co-authored-by: Ivan Kamkin <[email protected]>
  • Loading branch information
Denis-Averin and Ivan Kamkin committed Sep 4, 2023
1 parent 4db0e23 commit 60494e5
Show file tree
Hide file tree
Showing 20 changed files with 282 additions and 26 deletions.
19 changes: 13 additions & 6 deletions codegen/Templates/csharp/model_doc.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,24 @@
{{#model}}
# {{{packageName}}}.{{modelPackage}}.{{{classname}}}

{{#description}}
{{description}}

{{/description}}
{{#allowableValues}}
## Allowable values

{{#enumVars}}
{{#-first}}* **{{value}}**{{/-first}}{{^-first}}* {{value}}{{/-first}}
{{/enumVars}}
{{/allowableValues}}
{{#hasVars}}
## Properties

Name | Type | Description | Notes
---- | ---- | ----------- | -----
{{#parent}}
{{#parentVars}}
**{{name}}** | {{#isPrimitiveType}}**{{datatype}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{datatype}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
{{/parentVars}}
{{/parent}}
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{datatype}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{datatype}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
{{/vars}}

{{/hasVars}}
{{/model}}
{{/models}}
14 changes: 14 additions & 0 deletions codegen/Templates/dart/object_doc.mustache
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
{{#models}}{{#model}}# {{pubName}}.model.{{classname}}

## Load the model package

```dart
import 'package:{{pubName}}/api.dart';
```
{{#description}}
{{description}}
{{/description}}
{{#allowableValues}}
## Allowable values

{{#enumVars}}
* {{#-first}}**{{/-first}}{{{classname}}}.{{name}}{{#-first}}**{{/-first}}
{{/enumVars}}
{{/allowableValues}}
{{#hasVars}}

## Properties

Name | Type | Description | Notes
---- | ---- | ----------- | -----
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{datatype}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{datatype}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}
{{/vars}}
{{/hasVars}}
{{/model}}{{/models}}
12 changes: 12 additions & 0 deletions codegen/Templates/go/model_doc.mustache
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
{{#models}}{{#model}}# {{classname}}

{{#description}}
{{description}}

{{/description}}
{{#allowableValues}}
## Allowable values
{{#enumVars}}
{{#-first}}* **{{{classname}}}{{value}}**{{/-first}}{{^-first}}* {{{classname}}}{{value}}{{/-first}}
{{/enumVars}}
{{/allowableValues}}
{{#hasVars}}
## Properties

Name | Type | Description | Notes
---- | ---- | ----------- | -----
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{{datatype}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isDateTime}}[**{{^isContainer}}*{{/isContainer}}{{{datatype}}}**]({{^isContainer}}{{datatype}}{{/isContainer}}{{#isContainer}}{{complexType}}{{/isContainer}}.md){{/isDateTime}}{{#isDateTime}}**time.Time**{{/isDateTime}}{{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
{{/vars}}
{{/hasVars}}

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md){{/model}}{{/models}}
13 changes: 13 additions & 0 deletions codegen/Templates/php/model_doc.mustache
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
{{#models}}{{#model}}# {{classname}}
{{#description}}

{{description}}
{{/description}}
{{#allowableValues}}
## Allowable values

{{#enumVars}}
* {{#-first}}**{{/-first}}{{name}}{{#-first}}**{{/-first}}
{{/enumVars}}
{{/allowableValues}}
{{#hasVars}}

## Properties
Name | Type | Description | Notes
---- | ---- | ----------- | -----
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{datatype}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{datatype}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
{{/vars}}
{{/hasVars}}

[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)

Expand Down
23 changes: 23 additions & 0 deletions codegen/Templates/python/model_doc.mustache
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{{#models}}{{#model}}# {{classname}}

{{#description}}
{{description}}
{{/description}}
{{#allowableValues}}
## Allowable values

{{#enumVars}}
* {{#-first}}**{{/-first}}{{{classname}}}.{{name}}{{#-first}}**{{/-first}}
{{/enumVars}}
{{/allowableValues}}
{{#hasVars}}

## Properties

Name | Type | Description | Notes
---- | ---- | ----------- | -----
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{datatype}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{datatype}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
{{/vars}}
{{/hasVars}}

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md){{/model}}{{/models}}
2 changes: 1 addition & 1 deletion codegen/config-android.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"androidSdkVersion": "33",
"apiPackage": "com.aspose.barcode.cloud.demo_app",
"artifactId": "Android Application for Barcode Processing in the Cloud via REST API",
"artifactVersion": "23.7.0",
"artifactVersion": "23.8.0",
"groupId": "com.aspose",
"invokerPackage": "com.aspose.barcode.cloud.demo_app",
"modelPackage": "com.aspose.barcode.cloud.demo_app.model"
Expand Down
2 changes: 1 addition & 1 deletion codegen/config-dart.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"browserClient": false,
"pubDescription": "This SDK allows you to work with Aspose.BarCode for Cloud REST APIs in your Dart or Flutter applications quickly and easily",
"pubName": "aspose_barcode_cloud",
"pubVersion": "0.23.7",
"pubVersion": "0.23.8",
"useEnumExtension": true
}
2 changes: 1 addition & 1 deletion codegen/config-go.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"packageName": "barcode",
"packageVersion": "0.2307.0"
"packageVersion": "0.2308.0"
}
2 changes: 1 addition & 1 deletion codegen/config-java.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"artifactDescription": "Aspose.BarCode Cloud SDK for Java",
"artifactId": "aspose-barcode-cloud",
"artifactUrl": "https://www.aspose.cloud",
"artifactVersion": "23.7.0",
"artifactVersion": "23.8.0",
"developerEmail": "[email protected]",
"developerName": "Denis Averin",
"developerOrganization": "Aspose",
Expand Down
2 changes: 1 addition & 1 deletion codegen/config-php.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"artifactVersion": "23.7.1",
"artifactVersion": "23.8.0",
"invokerPackage": "Aspose\\BarCode"
}
2 changes: 1 addition & 1 deletion codegen/config-python.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"packageName": "aspose_barcode_cloud",
"packageUrl": "https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-python",
"packageVersion": "23.7.0",
"packageVersion": "23.8.0",
"projectName": "aspose-barcode-cloud"
}
6 changes: 3 additions & 3 deletions codegen/config.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"artifactVersion": "23.7.0",
"npmName": "aspose-barcode-cloud-node",
"npmVersion": "23.7.0",
"npmVersion": "23.8.0",
"packageName": "Aspose.BarCode.Cloud.Sdk",
"packageVersion": "23.7.1",
"packageVersion": "23.8.0",
"supportsES6": true
}
}
18 changes: 14 additions & 4 deletions scripts/start-release.bash
Original file line number Diff line number Diff line change
@@ -1,20 +1,29 @@
#!/bin/bash
#Run from aspose-barcode-cloud-codegen
set -euo pipefail

SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
which make || (
echo "Make is required"
echo "Install Make or use WSL"
exit 1
)

year=$(date +%y)
month=$(date +%-m)

major=${1:-$year}
minor=${2:-$month}

branch_name="release-${major}.${minor}"

SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
pushd "${SCRIPT_DIR}/.."

echo "Update Swagger specification..."
./update_swagger_spec.bash

echo "Switching to ${branch_name}"
git switch --create "${branch_name}" || git switch "${branch_name}"

pushd "${SCRIPT_DIR}/../submodules"
pushd "./submodules"
for d in */ ; do
pushd "$d"

Expand All @@ -27,3 +36,4 @@ done
python "${SCRIPT_DIR}/new-version.py" "${major}" "${minor}"

popd >/dev/null
popd >/dev/null
9 changes: 7 additions & 2 deletions scripts/update_all_package_dependencies.bash
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
#!/bin/bash

set -euo pipefail

which make || (
echo "Make is required"
echo "Install Make or use WSL"
exit 1
)

pushd "$(dirname "$0")/../submodules"

for d in */ ; do
pushd "$d"

wsl make update
make update

popd >/dev/null
done
Expand Down
Loading

0 comments on commit 60494e5

Please sign in to comment.