Search found 15 matches

by Seema
Wed Jul 26, 2023 2:26 pm
Forum: Common Problems
Topic: Strange behaviour with Swagger documentation output
Replies: 17
Views: 2346

Re: Strange behaviour with Swagger documentation output

Hi, Thank you for reporting this problem. I created a sample using the screenshot you provided, I reproduced the problem and I registered an internal issue for this. Please do the following steps for correcting the conversion in your application: Open the following jar file into the "Archive B...
by Seema
Wed Apr 19, 2023 7:40 pm
Forum: DITA (Editing and Publishing DITA Content)
Topic: Need trademark to appear only on the first instance in each topic
Replies: 4
Views: 606

Need trademark to appear only on the first instance in each topic

Hello, We are using the trademarks setting to apply the trademark to our product name. We have a conref for the product name on which we have applied the trademark setting. Is there a setting which will allow us to display the trademark symbol only to the first occurrence of the product name in each...
by Seema
Thu Mar 30, 2023 2:53 pm
Forum: DITA (Editing and Publishing DITA Content)
Topic: Integrating REST API Reference (OpenAPI) with DITA
Replies: 17
Views: 5511

Re: Integrating REST API Reference (OpenAPI) with DITA

Hello, Just a follow-up question on integrating Swagger documents with our regular docs. We are currently using the dynamic OpenAPI to DITA converter to publish our Swagger API documentation. I just wanted to know is it possible to generate interactive Swagger documentation (for example, like the on...
by Seema
Wed Mar 22, 2023 2:46 pm
Forum: Common Problems
Topic: Strange behaviour with Swagger documentation output
Replies: 17
Views: 2346

Re: Strange behaviour with Swagger documentation output

Hi Cosmin, I see what you mean now. Thanks for pointing that out. I usually import the file into the Swagger editor instead of pasting the contents, and although I did not get any prompt about the YAML conversion while importing the file, it may be possible that it converted the file to YAML when I ...
by Seema
Tue Mar 21, 2023 7:46 pm
Forum: Common Problems
Topic: Strange behaviour with Swagger documentation output
Replies: 17
Views: 2346

Re: Strange behaviour with Swagger documentation output

Hi Cosmin, Thank you for your response. The screenshot that I had attached to my previous post was actually from the JSON file itself (the same sample file I sent in my email) and not YAML. For this project, all of our API documentation is in JSON. In the screenshot, I had my JSON file open in the S...
by Seema
Mon Mar 20, 2023 3:16 pm
Forum: Common Problems
Topic: Strange behaviour with Swagger documentation output
Replies: 17
Views: 2346

Re: Strange behaviour with Swagger documentation output

Update: We removed the closing </strong> tag which didn't have a corresponding start <strong> tag from the description. That seems to have resolved at least two issues for us: The content that was not displaying in the API calls is now displaying Code block is displaying correctly too now after remo...
by Seema
Mon Mar 20, 2023 1:51 pm
Forum: Common Problems
Topic: Strange behaviour with Swagger documentation output
Replies: 17
Views: 2346

Re: Strange behaviour with Swagger documentation output

Hi Cosmin,
Thank you for letting me know about the code formatting.
For the other issues, I will send you the sample file by email.
Thank you,
Seema
by Seema
Thu Mar 16, 2023 7:43 pm
Forum: Common Problems
Topic: Strange behaviour with Swagger documentation output
Replies: 17
Views: 2346

Re: Strange behaviour with Swagger documentation output

Hello Cosmin, With respect to the Swagger documentation, I applied that workaround and the content under response codes is now showing. However, with respect to formatting, I was hoping to display each error code on a separate line, the way it appears in the Swagger editor. image.png But when I use ...
by Seema
Tue Mar 14, 2023 2:45 pm
Forum: Common Problems
Topic: Strange behaviour with Swagger documentation output
Replies: 17
Views: 2346

Re: Strange behaviour with Swagger documentation output

Hi Cosmin, Thanks for sending the edited file. Unfortunately, our anti-virus policy quarantined your email with the attachment. So, as a workaround, I uninstalled and then reinstalled Oxygen Author in the C drive but outside the Program Files folder. That seemed to do the trick. After changing the i...
by Seema
Mon Mar 13, 2023 5:55 pm
Forum: Common Problems
Topic: Strange behaviour with Swagger documentation output
Replies: 17
Views: 2346

Re: Strange behaviour with Swagger documentation output

Hello, Thank you for suggesting the workaround. However, when I open that file in the editor, it opens with a fatal error (screenshot attached for reference). And further, when I remove the content from line 180 and try to save the file, I get another error and I am unable to save the file with that...
by Seema
Thu Mar 09, 2023 8:25 pm
Forum: Common Problems
Topic: Strange behaviour with Swagger documentation output
Replies: 17
Views: 2346

Strange behaviour with Swagger documentation output

Hello, I am generating Swagger API documentation, and I am currently using the dynamic OpenAPI to Dita converter to convert our JSON files to DITA. However, I am encountering a strange behaviour in the generated PDF output. For example when I edit the documentation in the Swagger Editor, it displays...
by Seema
Mon Dec 19, 2022 6:41 pm
Forum: DITA (Editing and Publishing DITA Content)
Topic: Integrating REST API Reference (OpenAPI) with DITA
Replies: 17
Views: 5511

Re: Integrating REST API Reference (OpenAPI) with DITA

Hi Cosmin,
Thanks for clarifying.
Regards,
Seema
by Seema
Tue Dec 13, 2022 6:12 pm
Forum: DITA (Editing and Publishing DITA Content)
Topic: Integrating REST API Reference (OpenAPI) with DITA
Replies: 17
Views: 5511

Re: Integrating REST API Reference (OpenAPI) with DITA

Hello, Thanks, yes, the DITA Map containing a topic reference to the Swagger/OpenAPI documentation was published using the WebHelp Responsive scenario. The ditamap we used had some html-specific settings, we fixed that last week to include common settings and can now publish output in PDF format. Re...
by Seema
Thu Dec 08, 2022 2:49 pm
Forum: DITA (Editing and Publishing DITA Content)
Topic: Integrating REST API Reference (OpenAPI) with DITA
Replies: 17
Views: 5511

Re: Integrating REST API Reference (OpenAPI) with DITA

Hello, I am not the original poster, but just had a query there in relation to this topic. I am trying to integrate generate Swagger API documentation (JSON format) in Oxygen Author and was able to create HTML output using the instructions in this video: https://www.oxygenxml.com/demo/integrating_re...